From: Florian Müllner Date: Wed, 17 Jan 2024 04:52:10 +0000 (+0100) Subject: docs: Expand contribution section in README X-Git-Tag: archive/raspbian/50.5-1+rpi1~1^2~281^2~2^2~87 X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=1f22c6681a8a1f97429d9b132021ec6df64b0d5d;p=gnome-shell.git docs: Expand contribution section in README Provide a link to the relevant handbook section and some guidance for submitting a successful merge request, instead of just throwing two links at the user. Part-of: --- diff --git a/README.md b/README.md index 4f3841b18..dba27ce09 100644 --- a/README.md +++ b/README.md @@ -77,8 +77,23 @@ When in doubt, it is better to ask before opening an issue. To contribute, open merge requests at https://gitlab.gnome.org/GNOME/gnome-shell. -Commit messages should follow the [commit message guidelines][commit-messages]. +It can be useful to first look at the [GNOME handbook][mr-handbook]. +If a change likely requires discussion beyond code review, it is probably better to +open an issue first, or follow the process for [feature requests](#feature-requests). +Otherwise, creating a separate issue is not required. + +The following guidelines will help your change to be successfully merged: + + * Keep the change as small as possible. If you can split it into multiple + merge requests, please do so. + * Use multiple commits. This makes it easier to review and helps to diagnose + bugs in the future. + * Use clear commit messages following the [conventions][commit-messages]. + * Pay attention to the CI results. Merge requests cannot be merged until the + CI passes. + +[mr-handbook]: https://handbook.gnome.org/development/change-submission.html [commit-messages]: docs/commit-messages.md ## License